Add JSON help document generation and command examples#8
Merged
evanphx merged 1 commit intoFeb 17, 2026
Merged
Conversation
Add structured help documentation output as Go structs and JSON for processing into documentation. Includes HelpDoc()/HelpJSON() methods on both FlagSet and Dispatcher, with recursive command tree traversal, flag metadata extraction (including choices via ChoiceProvider interface), positional args, rest args, and flag groups. Also adds Example type and ExampleProvider interface so commands can register usage examples via WithExamples(), exposed through the help document JSON but not rendered in --help output.
phinze
approved these changes
Feb 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
HelpDoc()andHelpJSON()methods on bothFlagSetandDispatcherto generate structured help documentation as Go structs or JSONChoiceProviderinterface for extracting valid choices from flag valuesExampletype,ExampleProviderinterface, andWithExamples()command option for registering usage examples (exposed via JSON, not rendered in--help)Test plan